apitypes: openapi spec #2308
Merged
apitypes: openapi spec #2308
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
from
e22f298 to
38723ef
Compare
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
3 times, most recently
from
1c01176 to
8710b4d
Compare
Member
Author
|
Crozzy and I went through the endpoints this afternoon and made sure they were all in the OpenAPI document. I'll take another pass on the |
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
2 times, most recently
from
051419c to
c69e119
Compare
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
from
c69e119 to
d52b9c6
Compare
Member
Author
|
Okay, I think this is ready to go. This adds a bunch of documentation and tooling, but only makes a few code changes. Those will come in a later PR. |
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
3 times, most recently
from
af40d0d to
6110f81
Compare
crozzy
reviewed
Nov 10, 2025
Collaborator
crozzy
left a comment
crozzy
left a comment
There was a problem hiding this comment.
We've been through this and it LGTM, one ask I have is some doc to tell the developer how to update the openapi spec and perhaps how the different generation scripts interact.
Member
Author
|
Will do. |
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
from
6110f81 to
1644e2c
Compare
Signed-off-by: Hank Donnay <[email protected]>
Signed-off-by: Hank Donnay <[email protected]>
Creating this file is now handled by the same script that generates the OpenAPI doc, so being able to build it independently and needing to check it for drift don't make a ton of sense. Signed-off-by: Hank Donnay <[email protected]>
hdonnay
force-pushed
the
hack/apitypes/openapi
branch
from
1644e2c to
5891f64
Compare
crozzy
approved these changes
Nov 12, 2025
Collaborator
crozzy
left a comment
crozzy
left a comment
There was a problem hiding this comment.
Thanks for the guide, it worked with me after I updated the npm version
Member
Author
|
/fast-forward |
This comment was marked as resolved.
This comment was marked as resolved.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This series (split from #2266) adds JSON Schema documents for all the types exposed in the HTTP API and adds a way to generate the OpenAPI specification from those, a
jqscript, and some other loose files.TODO
"description"members for the JSON Schema documents."description"members for the OpenAPI document../Documentation/reference/api.md) is at least as-useful as it was.Coming later in series: